home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / welc101.zip / WELCOME.DOC < prev    next >
Text File  |  1992-04-11  |  19KB  |  416 lines
  1.  
  2.  
  3.                       W E L C O M E     v 1 . 0 1
  4.                       ---------------------------
  5.  
  6.                For Searchlight BBS Versions 2.15 and 2.25!
  7.               (c)1992 Cyclone Software. All Rights Reserved
  8.                          Release Date : 4/11/92
  9.  
  10. OVERVIEW:
  11.  
  12.     WELCOME is a great utility for the Sysop and an informative door for
  13. the users. Designed to allow the user and the Sysop to see more
  14. information about the BBS's Stats and the current callers stats. Here is
  15. a quick rundown of WELCOME's features:
  16.  
  17. o Allows callers to see their access level. Since most BBS's have a
  18.   different number set for different levels, WELCOME will give the call
  19.   their access info in plain english for their status.
  20.  
  21. o Tells caller their subscription remaining and days left (optional)
  22.   with Searchlight 2.25 or allows the Sysop to generate a one-line quote
  23.   or message to the caller. (See below for more information).
  24.  
  25. o Asks users if they would like to see the BBS's stats in a
  26.   Searchlight-like Yes/No prompt. This allows WELCOME to blend right in!
  27.  
  28. o Gives the caller information on the BBS (ex. BBS Name, Location,
  29.   SL Version, Sysop's Name, Number Of Calls and two NEW stats not normally
  30.   offered by Searchlight Number Of Calls Today and Today's New User
  31.   Counter).
  32.  
  33. o Gives the caller personal information (ex. Name, Location, First Call,
  34.   Last Call, % Of Calls To The System, UL Bytes, DL Bytes, % of DLs to
  35.   ULs, etc).
  36.  
  37. o When a New User firsts calls, WELCOME will send the SYSOP (or whatever
  38.   name you choose) a letter in mail with the Callers information (Name,
  39.   Location, Phone Number, Callers Baud Rate, Time They Called, and Date
  40.   They Called). This feature is built into WELCOME and requires NO
  41.   additional external mailers such as SLMAIL. You can also make a carbon
  42.   copy of the message to your COSYSOP or whomever. (COSYSOP feature is
  43.   optional)
  44.  
  45. o If a file called NEWUSER.TXT exists, WELCOME will automatically send
  46.   this message to the new user. This allows you to WELCOME a new user to
  47.   your board. If NEWUSER.TXT doesn't exist, WELCOME does not leave a
  48.   message.
  49.  
  50. o Allows you to set chat availablity to certain people whom you wish to
  51.   be available to. This is useful to allow your Cosysops, friends,
  52.   family, etc, to get a hold of you when you are not available for chat.
  53.   This is also set to allow you to set certain hours for you to be
  54.   available.
  55.  
  56. o Allows you to set what access level Searchlight allows a caller to
  57.   leave a quote before logging off. For example you can set it so
  58.   NEWUSERS can't leave a quote but validated users can. (NOTE: This does
  59.   NOT effect the QUOTES command).
  60.  
  61. o Allows you to set a subboard that callers are reset to when they call.
  62.   (Optional)
  63.  
  64. o Uses color choices set in your CONFIG.SL2 to make WELCOME look like
  65.   part of the system!
  66.  
  67. o Has a Searchlight-like Status line on the 25th line, that can be
  68.   turned ON or OFF.
  69.  
  70. o Fully configurable!
  71.  
  72.  
  73. SETUP:
  74.  
  75. Oh no, now the EASY part! :) Since WELCOME takes most of its information
  76. directly from Searchlight's datafiles, it requires very LITTLE setup.
  77. WELCOME is designed to be ran from either Searchlight's AutoLogin Door
  78. or from the STARTUP.MNU on Searchlight 2.25. WELCOME requires NO
  79. nightly events, it will automatically do what needs to be done WHEN
  80. it needs to be done.
  81.  
  82. GETTING STARTED:
  83.  
  84. (1) First you will want to create a directory off your main BBS datafile
  85.     directory (Ex. C:\BBS1\WELCOME).
  86.  
  87. (2) Copy the files from WELC100.ZIP to that directory.
  88.  
  89. (3) Look over the SAMPLE.CFG file included with WELC100.ZIP to see how
  90.     its config file is setup. You can either use the DOS TYPE command or
  91.     print it out on your printer with the COPY SAMPLE.CFG PRN command.
  92.     THIS IS JUST A SAMPLE FILE AND WILL NOT RUN WITH WELCOME!
  93.  
  94. (4) Load up a text editor such as Searchlight's editor, QEdit, or
  95.     MS-DOS 5.0's EDIT command. Now load up WELCOME.CFG, this is the
  96.     config file you will be using. Change all the information to match
  97.     your system. Here is a rundown about what all this means.
  98.  
  99.   1.    WELCOME 1.0             {WELCOME Version Number - DO NOT CHANGE!}
  100.   2.    Watertown, NY           {BBS's Location}
  101.   3.    Searchlight BBS 2.25M   {Current Searchlight Version Info}
  102.   4.    Travis Feisthamel       {SYSOP's first and last names}
  103.   5.    1-12-91                 {BBS's Start Date - Day BBS Went On-Line}
  104.   6.    SYSOP                   {To whom WELCOME sends NEWUSER info to}
  105.   7.    COSYSOP                 {Carbon Copy #6 to or OFF to turn OFF}
  106.   8.    ON                      {Searchlight-like Status Line ON/OFF Toggle}
  107.   9.    YES                     {Send Press [RETURN]: at beginning of prg?}
  108.  10.    YES                     {Send Press [RETURN]: at the end of program?}
  109.  11.    WELCOME.LOG             {Name of WELCOME's Caller Log}
  110.  12.    100                     {First access level - See Below}
  111.  13.    NEW USER                {User Status String - Tells User Their Level}
  112.  14.    Please Register For Greater Access!  {One line quote to send to user}
  113.  15.    125                     {Second access level - See Below)
  114.  16.    VALIDATED USER          {on and on.........}
  115.  17.    Please Register For Greater Access!
  116.  18.    150
  117.  19.    FULL ACCESS PAID CALLER
  118.  20.    #                      {See below for information on the '#' command}
  119.  21.    175
  120.  22.    FULL ACCESS PAID CALLER (ADULT PERMISSION GRANTED)
  121.  23.    #
  122.  24.    255
  123.  25.    SYSOP ACCESS           {Notice there is not quote or message for this}
  124.                                {level, WELCOME automatically tells the SYSOP}
  125.                                {The Number Of Calls Today and New Users Today}
  126.  26.    Registration Expires:  {String displayed before expiration date}
  127.  27.    GENERAL                {Reset user subboard to of OFF to turn off}
  128.  28.    9 22                   {Chat time ON and OFF separated by a space}
  129.  29.    125                    {Turn quotes ON at this level or higher}
  130.  
  131.     The first 11 are pretty much self explainatory but I will still go
  132.     over them with you.
  133.  
  134.    1. Leave this line alone, this just tells WELCOME that you will be
  135.       working with WELCOME 1.0's configuration file. DO NOT EDIT this line
  136.       it is added for future reference and upgrades.
  137.  
  138.    2. The location of your BBS. This is added to the BBS Stats when a
  139.       caller hits YES to read them. This can be a city or anyother
  140.       small string you want it to be. Don't make it too big or it could
  141.       corrupt how your output could look. I would say keep it shorter than
  142.       25 characters.
  143.  
  144.    3. This is a simple text line telling the users which version of
  145.       Searchlight BBS you are running, this is included to easily change
  146.       if an upgrade version of Searchlight is released.
  147.  
  148.    4. The SYSOP's first and last names. I think you can figure this out! :)
  149.  
  150.    5. Date the BBS first went on-line. Place the date in which the BBS
  151.       started on this line.
  152.  
  153.    6. Line 6 is to tell WELCOME whom to send the NEWUSER information
  154.       to, default is SYSOP.
  155.  
  156.    7. Line 7 tells WELCOME whom to send a carbon copy of the NEWUSER
  157.       information to, default is COSYSOP. Placeing OFF here turns this
  158.       feature off.
  159.  
  160.    8. Use this option to turn the Searchlight-like 25th Status line ON
  161.       or OFF. This MUST be in CAPS for WELCOME to read it properly.
  162.       Simply place an ON or and OFF on the line.
  163.  
  164.    9. This lets WELCOME know if it should place a Press [RETURN]: at the
  165.       very beginning of the program. This is useful if setting WELCOME
  166.       up as an autodoor. Placeing YES or NO in caps will turn it ON or
  167.       OFF.
  168.  
  169.   10. This lets WELCOME know if it should place a Press [RETURN]: after
  170.       the information is displayed. You would use this if you are
  171.       setting WELCOME up in an Autodoor, for instance, or in the Startup
  172.       menu (SL 2.25) and want the user to pause to read it. Placeing YES
  173.       or NO in caps will turn it ON or OFF.
  174.  
  175.   11. This is the name of WELCOME's LOG file. This file keeps track of
  176.       the DATE, which is used to help WELCOME maintain its built in nightly
  177.       maintence, LAST CALLER (Since SL reset this before WELCOME is called
  178.       up), and the number of Calls Today and New Users Today which is
  179.       not normally told by Searchlight.
  180.  
  181.    The following 14 lines are a little more tricker to setup, they tell
  182.    WELCOME what to do based on the users message access level. The first
  183.    line tells WELCOME the users minimum access level, the second line is
  184.    the line displayed to the caller telling them their USER STATUS, and
  185.    finally the third line is the one line message or subscription
  186.    information that the SYSOP sets up. This will keep going on for all
  187.    five levels (Currently this is the limit in WELCOME, a future release
  188.    will fix this limit).
  189.  
  190.     NOTE: Please do not set line 12 to be higher than Searchlight's
  191.     MINIMUM ACCESS NEEDED TO LOGON. If unsure, please run CONFIG.EXE
  192.     and check this out, it should be the same.
  193.  
  194.     USING THE # COMMAND: On the line where you place the one line quote,
  195.     you can place an '#' to tell WELCOME to give the caller their
  196.     current subscription information:
  197.  
  198.        Ex. Registration Expires: 5/1/93              Days Remaining: 145
  199.            /\/\/\/\/\/\/\/\/\/\/\
  200.        NOTE: This is the string in line 26!
  201.  
  202.     WELCOME will automatically give the correct line to a caller if
  203.     their level is between the last level and the next level. For
  204.     example in the above config if I had a caller call that was say
  205.     level 124 they will still get the NEWUSER information, but if they
  206.     were 125 they will get the VALIDATED USER information.
  207.  
  208.     There is no one line message for level 5's since WELCOME defaults to tell
  209.     the SYSOP how many calls your system had since midnight and today's new
  210.     user count, which is kept track of in the WELCOME.LOG.
  211.  
  212.   26. This is the string that is JUST BEFORE the expiration date if you
  213.       used the # command. I have added this option for some BBS's that
  214.       wish to call this something different. Here are a few examples:
  215.       Registration Expires:, Subscription Expires:, Account Terminated:, etc.
  216.       This is for Searchlight 2.25's expiration date. This line has no
  217.       effect if you are using Searchlight 2.15.
  218.  
  219.   27. This is the name of the SUBBOARD to reset your users to when they
  220.       first call. This is useful if you want your users to automatically
  221.       be on a certain subboard when they call. For example, say you have
  222.       a subboard called GENERAL which is the first subboard in your
  223.       list, you can make them automatically JUMP to that subboard when
  224.       they call. To turn this off just enter OFF instead of a subboard
  225.       name. This command MUST be in caps.
  226.  
  227.   28. WELCOME looks for a file called CHATLIST.SL2 when it is ran, if
  228.       this file is found and the user is listed, WELCOME will
  229.       automatically make the local sysop available for chat. (See below)
  230.       Line 28 in WELCOME.CFG allows the sysop to set the times to be
  231.       available in military time. This is done by placeing the ON TIME
  232.       and then a space and then OFF TIME. For example to make you
  233.       available from 9AM to 11PM you would enter:
  234.          9 22
  235.       If you wish to be available at ALL times just enter 0 23. Zero '0'
  236.       represents midnight.
  237.  
  238.   29. This is the level at which you want to turn on Searchlight's leave
  239.       a quote feature at logoff. This SHOULD have been built into
  240.       Searchlight but wasn't. For example, in the above sample
  241.       WELCOME.CFG file, a NEWUSER wouldn't be able to leave a quote,
  242.       only VALIDATED USERS and higher.
  243.  
  244.                   ALL DONE WITH WELCOME's CONFIG FILE!
  245.  
  246. (5) Setting WELCOME up with Searchlight is the next step. First you must
  247.     decide if you want to set WELCOME up as the LOGIN AUTODOOR or the
  248.     STARTUP.MNU. For Searchlight 2.15 this choice is easy, since this version
  249.     of Searchlight does not have the STARTUP menu.
  250.  
  251. (6) Setting up! Please read the approriate section:
  252.  
  253.                 ENTER IN THE FOLLOWING INFORMATION
  254.  
  255.       USING THE LOGIN AUTODOOR:
  256.  
  257.        *1. Command ........................ WELCOME.EXE {path to CONFIG.SL2}
  258.        *2. Directory Path ................. {Path To WELCOME}
  259.         3. Communications Support ......... Standard
  260.         4. Abort Method ................... Terminate
  261.         5. Write Protection ............... No
  262.  
  263.       USING THE STARTUP MENU:
  264.  
  265.        Load up Searchlight's MENU program and the STARTUP menu. Press F1 to
  266.        edit commands. Then enter into the area you wish WELCOME to be
  267.        displayed. (I have mine right after the PressReturn). Now press F1
  268.        again to add a new command and choose DOOR. Now enter in the following:
  269.  
  270.         1. Command Name ................... Welcome
  271.         2. Command Key .................... {Leave Blank}
  272.         3. Description .................... Welcome v1.01
  273.         4. Minimum Access ................. 0
  274.         5. Maximum Access ................. 255
  275.  
  276.        Items 6 through 8 leave blank.
  277.  
  278.         9. Help Levels .................... All
  279.       *10. Door Command ................... WELCOME.EXE {path to CONFIG.SL2}
  280.       *11. Directory Path ................. {Path To WELCOME}
  281.        12. Communications Support ......... Standard
  282.        13. Abort Method ................... Terminate
  283.        14. Write Protection ............... No
  284.        15. Parameter File ................. None
  285.        16. Pause After Door ............... No
  286.  
  287.  * Note: For the command and directory paths you must enter this in to suit
  288.          your Searchlight BBS. The CONFIG.SL2 MUST be the correct file for the
  289.          current node. If you are running a multi-node SLBBS and have your BBS
  290.          set up as BBS1, BBS2, BBS3, etc. you could put for the Command:
  291.          WELCOME.EXE C:\BBS%O. This tells Searchlight to send the node number
  292.          in the path, for the above example Searchlight would translate it to:
  293.          WELCOME.EXE C:\BBS1. {Leave the period out!}. If you are not running
  294.          your multinode system this way you will need to create a batch file
  295.          for each node like to following:
  296.  
  297.          NODE1.BAT
  298.          @echo off
  299.          cd\bbs\welcome
  300.          welcome c:\bbs
  301.  
  302.          NODE2.BAT
  303.          @echo off
  304.          cd\bbs\welcome
  305.          welcome c:\bbs2
  306.  
  307.          ...etc, etc.
  308.  
  309.          Then enter in your Command as NODE%O.BAT and directory as a blank.
  310.          Hope this helps out some. The Directory Path would be the path you
  311.          created above in Option 1 except in the above case.
  312.  
  313. READY TO GO:
  314.  
  315.   You should now be ready to go, try loggin on to your system and see
  316.   what WELCOME can really do. When you call you should see at the top:
  317.  
  318.   Good xxxxxxxx Sysop, and welcome to xxxxxxxx BBS.                  WELCOME
  319.   User Status: xxxxxxxxxxxx
  320.   Today's Total Calls: 0                   Today's New Users: 0
  321.  
  322.   Would You like to see the xxxxxxxxxxx's stats? [YES] No. (Uses SL's colors)
  323.  
  324.   When you hit YES, you should see the BBS's and YOUR Stats. Notice
  325.   that the Today's Calls and Today's New Users are both 0. This is
  326.   because WELCOME has never before been ran on your system. For the
  327.   first day you might want to use Searchlight's USER/CALLLOG command to
  328.   see how many calls you have had TODAY on your system. Then use a text
  329.   editor and edit the WELCOME.LOG to be the following:
  330.  
  331.   {Line 1 has the date, leave this alone}   ex.  Wed April 1, 1992
  332.   SYSOP {This is the last caller}           ex.  SYSOP
  333.   {Place Total Number Of Calls Today Here}  ex.  35
  334.   {Place Today's New User Number Here}      ex.  2
  335.  
  336.   Of course, substitute the 32 and 2 with the number you come up with on
  337.   your system. WELCOME will then automatically reset this after the
  338.   first call at Midnight. No need for another event because WELCOME does
  339.   this automatically.
  340.  
  341.   OPTIONAL FEATURES:
  342.  
  343.     NEWUSER.TXT - Send a message to a new user!
  344.  
  345.     Create a file called NEWUSER.TXT and place it in WELCOME's
  346.     directory, if you would like to send a little message to a new user.
  347.     You can use Searchlight's color codes and 2.25's metastatements! To
  348.     easily create this file use Searchlight's built in text editor. If
  349.     this file is not created WELCOME will not send a message to a new user.
  350.     See the sample NEWUSER.TXT file more information.
  351.  
  352.     CHATLIST.SL2 - Listing of users to be available to.
  353.  
  354.     Create a file called CHATLIST.SL2 and place all the people you wish
  355.     to be available for chatting with. Place all names exactly as it
  356.     appears in their USER file in ALL caps. Place one name per line, see
  357.     the sample CHATLIST.SL2 for information.
  358.  
  359.   E N J O Y!
  360.  
  361.   DISCLAIMER:
  362.  
  363.   I, Travis Feisthamel, nor Cyclone Software are to be held liable for
  364.   any damages that WELCOME should cause to your system or software. This
  365.   program has been tested to be bugfree to the best of our knowledge.
  366.   This means that if WELCOME should corrupt a datafile or something, it
  367.   is your loss. USE AT YOUR OWN RISK!
  368.  
  369.   REGISTRATION:
  370.  
  371.   The Shareware copy of WELCOME is a full featured version, it is NOT
  372.   Crippleware and will work exactly the same as the REGISTERED version.
  373.   By registering, however, you remove the UNREGISTERED Copy line at the
  374.   bottom of the screen, the five short beeps, and the 10 sec time delay.
  375.   This also will add in your BBS Name. The registration price for
  376.   WELCOME is $10, which I feel is fair for all it does. This will also
  377.   get you ANY future upgrades FREE for the download. We have a lot
  378.   planned for WELCOME, so keep watch. Copy the WELCOME.REG form to your
  379.   printer and send it in, I will then send you a letter telling you it
  380.   is available for download from the StarNet BBS. (You also get a FREE
  381.   membership to The StarNet BBS).
  382.  
  383.   SUPPORT:
  384.  
  385.    If you have any QUESTIONS, COMMENTS, or IDEAS direct them to me,
  386.    Travis Feisthamel, at one of the following BBS's:
  387.  
  388.          StarNet BBS - (315) 786-0778  1200-14,400 (US ROBOTICS DS HST)
  389.          StarNet BBS - (315) 786-0779  300-2400 Baud
  390.  
  391.                           * The StarNet BBS *
  392.    * OFFICIAL SEARCHLIGHT BBS DEALERSHIP FOR THE NEW ENGLAND STATES *
  393.  
  394.     Liberty Mall BBS - (315) 788-0232  1200-14,400 (HST)
  395.     Liberty Mall BBS - (315) 788-8482  300-2400 Baud
  396.     Searchlight BBS  - (516) 516-2566  300-14,400 (US ROBOTICS DS HST)
  397.  
  398.    For a faster responce please call the StarNet BBS.
  399.  
  400.   THANKS:
  401.  
  402.     I would like to give special thanks to Steven Gunn, at the
  403.     Liberty Mall BBS, for his help in Beta testing WELCOME, and to my
  404.     COSYSOP, Darin Keggins, for giving me some ideas for WELCOME.
  405.  
  406.   CREDITS:
  407.  
  408.     Searchlight BBS is a product of Searchlight Software
  409.     WELCOME is a product of Cyclone Software
  410.  
  411.   ADDITIONAL:
  412.  
  413.     For all you SYSOPS still running, Searchlight 2.15, I recommend you
  414.     upgrade to Searchlight 2.25! This is the best version yet! It is
  415.     more or less a BBS construction kit! As you could see above!
  416.